Overview
What it is.
Medusa Automations as we call it, is a service that allows us to publish your content automatically according to certain configurations and your needs.
How it works.
The service searches and retrieves files from a specific path in an AWS S3 bucket, processes them and creates publications automatically according to a predefined schedule. If triggered manually it can also update publications that have already been published.
This is a simple flow diagram about How it Works:
caution
So far, we can only upload and update publications from PDF files. EPUBs and Audiobooks are not supported
How to set up your automation
You can set the system to automatically publish your content in three simple steps:
- Contact [email protected] and ask for access to the AWS S3 Bucket.
- Upload your files following the naming convention(see below)
- Fill the following FORM with information about your configuration (more details below)
Naming convention
When uploading your files they should be compliant with the following naming convention:
prefix-yymmdd-xxx.pdf
Where:
- prefix: it is the name of an edition or some short name to identify a group of the uploaded publications. Example: diario-dia.
- yymmdd: it is the date on which the file will be uploaded (
yy
two digits of the year,mm
two digits of the month andtwo
digits of the day) Example: 220824. - xxx: If a publication consists of multiple files you must add here the page number (each file would be a page in the publication). In the case the file is a complete publication you just need to add 000
Example:
For a publication with multiple pages:
diario-dia-220824-001.pdf
diario-dia-220824-002.pdf
diario-dia-220824-003.pdf
If there is one file that contains all the pages, it should be something like this:
diario-dia-220824-000.pdf
Configuration file
To set up your automation, we need you to upload a .csv file to this LINK with the following information in columns:
Column | Description |
---|---|
Filename | Name of the file as present in the FTP |
Publication name | Name of the publication (title) |
Folder | Name of the folder where the files are grouped (/diario-dia) |
Prefix | Prefix of the file |
Edition | Name of the edition |
Publishing time | Hour when the automation must run (we translate it to a crontab expression |
Publish Days | Days of the week when the automation must run (we translate it to a crontab expression |
Early Access from | Start of the early access time window (optional) |
Early Access to | Finish of the early access time window (optional) |